Skip to content

documentation: Info about offline s3 bucket key when creating feature group #2646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 21, 2021
Merged

Conversation

can-sun
Copy link
Contributor

@can-sun can-sun commented Sep 20, 2021

Issue #, if available:
Documentation offline_store_kms_key_id is not inclusive and lead charging customers more on encryption.

Description of changes:
Add more descriptive documentation message of offline_store_kms_key_id in create feature group to elaborate how to bring down the cost of using bucket key.

Testing done:
tox

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

  • I have read the CONTRIBUTING doc
  • I used the commit message format described in CONTRIBUTING
  • I have passed the region in to all S3 and STS clients that I've initialized as part of this change.
  • I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)
  • I have used unique_name_from_base to create resource names in integ tests (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@paul-cb paul-cb self-requested a review September 20, 2021 22:11
paul-cb
paul-cb previously approved these changes Sep 20, 2021
@sagemaker-bot
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: sagemaker-python-sdk-unit-tests
  • Commit ID: 6267185
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@paul-cb paul-cb requested review from jkroll-aws and mchoi8739 and removed request for mchoi8739 September 20, 2021 23:53
reduce AWS KMS requests costs by up to 99 percent.
For more information, see the S3 documentation for
`Bucket Key
<https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html>`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AWS KMS key ID for offline store.
If a KMS encryption key is not specified, SageMaker encrypts all data at
rest using the default AWS KMS key. By defining your bucket-level key for SSE, you can
reduce the cost of AWS KMS requests.
For more information, see
Bucket Key <https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html>_
in the Amazon S3 User Guide.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(You should not use any marketing words in the sdk docstrings.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revised according to your comments, thanks!

paul-cb
paul-cb previously approved these changes Sep 21, 2021
@shreyapandit shreyapandit changed the title Add documentation for offline s3 bucket key when creating feature group documentation: Add documentation for offline s3 bucket key when creating feature group Sep 21, 2021
@paul-cb paul-cb requested review from mchoi8739 and removed request for jkroll-aws and mchoi8739 September 21, 2021 02:58
@shreyapandit shreyapandit changed the title documentation: Add documentation for offline s3 bucket key when creating feature group documentation: Info about offline s3 bucket key when creating feature group Sep 21, 2021
@shreyapandit shreyapandit merged commit 6a782d9 into aws:master Sep 21, 2021
jerrypeng7773 pushed a commit to jerrypeng7773/sagemaker-python-sdk that referenced this pull request Sep 24, 2021
EthanShouhanCheng pushed a commit to SissiChenxy/sagemaker-python-sdk that referenced this pull request Jan 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants